/*
 * Copyright 2006-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.martinimix.webflow.accessor;

import java.util.Locale;

import org.springframework.webflow.execution.RequestContext;

/**
 * Provides a servlet request locale accessor appropriate for determining
 * the current locale from a servlet context. 
 * 
 * @author Scott Rossillo
 *
 */
public class HttpServletRequestLocaleAccessor
	extends AbstractHttpServletRequestObjectAccessor
	implements LocaleAccessor {

	/* (non-Javadoc)
	 * @see net.martinimix.webflow.accessor.LocaleAccessor#getLocale(org.springframework.webflow.execution.RequestContext)
	 */
	public Locale getLocale(RequestContext context) {
		
		return super.getHttpServletRequest(context).getLocale();
	}

	/**
	 * Returns the current request's locale.
	 * 
	 * @see net.martinimix.webflow.accessor.FlowObjectAccessor#getObject(java.lang.String, org.springframework.webflow.execution.RequestContext)
	 */
	public Object getObject(String objectName, RequestContext context) {
		return this.getLocale(context);
	}

	/**
	 * Throws an UnsupportedOperationException; the locale cannot be modfied.
	 * 
	 * @throws UnsupportedOperationException this method may not update the 
	 * request <code>Locale</code>
	 */
	public void putObject(String objectName, Object object, RequestContext context) {
		throw new UnsupportedOperationException("Cannot set the locale!");
	}
}
